Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Start documentation #43

Merged
merged 9 commits into from
May 2, 2024

Conversation

lukaspie
Copy link
Collaborator

No description provided.

@lukaspie lukaspie linked an issue Apr 30, 2024 that may be closed by this pull request
5 tasks
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8894751703

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 64.514%

Totals Coverage Status
Change from base Build 8876044305: 0.0%
Covered Lines: 2198
Relevant Lines: 3407

💛 - Coveralls

@coveralls
Copy link

coveralls commented Apr 30, 2024

Pull Request Test Coverage Report for Build 8921471274

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.06%) to 64.577%

Totals Coverage Status
Change from base Build 8876044305: 0.06%
Covered Lines: 2204
Relevant Lines: 3413

💛 - Coveralls

@lukaspie lukaspie force-pushed the 11-doc-how-to-write-your-own-sub-reader-for-xps-data branch from 391da59 to d6baaa9 Compare April 30, 2024 13:08
@lukaspie lukaspie requested review from domna and mkuehbach April 30, 2024 14:52
Copy link

@mkuehbach mkuehbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is quite a sophisticated start @lukaspie, I have not much to comment here, mainly focusing on other work at the moment some points catched my thoughts though:

  • You have currently some documentation still on the repo's README.md and some already in the doc, do you plan to remove most in the README.md cuz single source principle could be the README is just the link to the doc and maybe here its getting started page
  • I like that you picked up some of the work and thoughts from EM I also like the individual acknowledgements for examples in the reference page

To me this reads ready for a first release as it is meaty enough to be discussed by XPS experts and the community

@lukaspie
Copy link
Collaborator Author

lukaspie commented May 2, 2024

  • You have currently some documentation still on the repo's README.md and some already in the doc, do you plan to remove most in the README.md cuz single source principle could be the README is just the link to the doc and maybe here its getting started page

I removed some parts from the README now and replaced them by a link to the docs. For the individual examples, I kept the README, so people can see them immediately in the repo as well. Maybe eventually the docs could also just usethe README files to populate the docs (or vice-versa).

@lukaspie lukaspie merged commit b1ec3a2 into main May 2, 2024
6 checks passed
@lukaspie lukaspie deleted the 11-doc-how-to-write-your-own-sub-reader-for-xps-data branch May 2, 2024 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc: how to write your own sub-reader for XPS data
4 participants